home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / list75f.arc / DRLIST.DOC < prev    next >
Text File  |  1990-11-07  |  24KB  |  576 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                         DRLIST Version J
  7.  
  8.                 (c) Copyright Vernon D. Buerg 1986-89
  9.  
  10.  
  11.  
  12.                      Special BBS/CTTY Version
  13.                      ________________________
  14.  
  15.  
  16.                            Sept 17, 1989
  17.  
  18.  
  19.  
  20.  
  21.                         Table of Contents
  22.                         -----------------
  23.  
  24.                 Description ......................  1
  25.                 Display format ...................  2
  26.                  Status line .....................  2
  27.                  Command line ....................  3
  28.                 Keys and commands ................  4
  29.                  Positioning to lines ............  5
  30.                 Cloning procedure ................  6
  31.                  DEBUG Information ...............  7
  32.                  Screen attributes ...............  8
  33.                 Searching for text................  9
  34.                 Filtering ........................ 10
  35.                 Update history ................... 11
  36.                 Special version remarks .......... 12
  37.                 Restrictions ..................... 13
  38.  
  39.                                                       DRLIST     Page 1
  40.  
  41.  Command  DRLIST
  42.  -------------
  43.  
  44.  Purpose:  To display the contents of an ASCII text file,  line by  line
  45.         with the aid of scrolling, positioning and filtering commands.
  46.  
  47.  Format:   DRLIST  [d:][path]filename[.ext]
  48.  
  49.  Remarks:  An ASCII file of any size may be listed.
  50.  
  51.            The "filename" is optional.  If omitted, you are prompted  to
  52.         to enter  a filename.   You may  include drive,  path, and  wild
  53.         cards in the file name.   The first file which matches  the name
  54.         is displayed until an end-of-file character is encountered. Each
  55.         file which matches the "filename" may be displayed.
  56.  
  57.            DRLIST was  designed to display ASCII files.  That  is, files
  58.         which  contain  text  and  not  binary  or  control codes.  Text
  59.         characters  usually  range  from a  value of 32 to 127.  To view
  60.         binary files (COM, EXE, etc), the D-key hex dump display  option
  61.         is available.
  62.  
  63.            Characters  below  32  (a  blank)  are  replaced with a funny
  64.         character to indicate that a non-displayable character has  been
  65.         encountered.  This character is an upside-down question mark.
  66.  
  67.            Characters above 127 may be valid graphic characters, and may
  68.         be displayed if  the '8' command  is in effect.   To insure that
  69.         characters above ASCII value 127 are not displayed, use the  '7'
  70.         command.
  71.  
  72.            The top line of the display gives the file name, current right
  73.         scroll offset, and the file's creation date and time. Optionally,
  74.         a ruler may be displayed on the top line by using the R key.
  75.  
  76.            The  file  is  displayed  with  one  logical  record  on each
  77.         80-column display line.   A logical record  ends in a  linefeed.
  78.         The maximum logical record may  be 256 characters long.  If  the
  79.         record exceeds 80  characters, you may  view the portion  beyond
  80.         the 80 columns  by using the  scroll right command,  or by using
  81.         the Wrap feature.
  82.  
  83.            The Wrap  command toggles  ON or  OFF the  wrapping of  lines
  84.         longer than 80 characters.  With Wrap on, lines are displayed in
  85.         their  entirety,  80  characters  per  display line.  The scroll
  86.         -left and -right functions are disabled when Wrap is ON.
  87.  
  88.            The file may  be PRINTed as  it it displayed.   The P command
  89.         toggles  the  printer  on  or  off.   When  first entered, the P
  90.         command causes the current screen  to be printed.  As new  lines
  91.         are displayed, they too are printed.  Printing may be stopped by
  92.         entering another P command.  The PrtSc key may also be used, but
  93.         the title and prompt lines will be printed with the lines of the
  94.         file. Empty lines cause a line to be skipped on the printer. The
  95.         letter P is displayed in column 80 of the top line while printing.
  96.                                                       DRLIST     Page 2
  97.  
  98.  Display format
  99.  --------------
  100.  
  101.            The monitor display is defined in terms of lines and columns.
  102.         A typical monitor can display 25 lines of 80 columns each. DRLIST
  103.         attempts to use the number of lines and columns for the monitor
  104.         mode in use.  For example, if the monitor is in 40 column mode,
  105.         DRLIST displays only 40 characters per line.
  106.  
  107.            The top line of the display is called the Status line.  The
  108.         bottom line is called the Command line.  The remaining lines are
  109.         called the primary display window, and are usually lines 2
  110.         through 23.
  111.  
  112.  
  113.  Status line format
  114.  ------------------
  115.  
  116.     The Status line has the following format:
  117.  
  118.     DRLIST   lllll +sss mm/dd/yy hh:mm  bKMPSW  - filename
  119.  
  120.     where,
  121.  
  122.         'DRLIST'     is the name of this program
  123.  
  124.         'lllllll'  is the line number of the first line in the
  125.                   display window (usually on line 2)
  126.  
  127.         '+sss'     if displayed, this is the Scroll amount, in
  128.                   multiples of 20, corresponding to the number
  129.                   of columns that the display has been shifted
  130.                   to the right to view records longer than 80
  131.  
  132.         'mm/dd/yy' is the file's creation date
  133.         'hh:mm'    is the file's creation time
  134.  
  135.         'D'       indicates that the hex Dump display option is in use
  136.         'b'       indicates whether the 7-bit, 8-bit, or *-option is
  137.                   in use
  138.         'K'       indicates that the Keyboard flush option is in use
  139.         'M'       indicates that tests for monitor retrace are not made
  140.         'P'       indicates that Print is in use
  141.         'S'       indicates that the C (file sharing) is in use
  142.         'W'       indicates that the Wrap mode is in effect
  143.                                                       DRLIST     Page 3
  144.  
  145.  Command line format
  146.  -------------------
  147.  
  148.     The Command line has the following format:
  149.  
  150.     command message ______ Keys: Num-keypad Q=next X=exit ?=Help
  151.  
  152.     where,
  153.  
  154.       'command' indicates the current process:
  155.  
  156.           'Command'   you are being asked to enter a command
  157.                        enter the letter, or press the keys for
  158.                        the action to perform
  159.  
  160.           'Reading '   the file data is being read
  161.           'Filter  '   the file data is being formatted for display
  162.           'Scanning'   the Scan/Find text is being searched for
  163.  
  164.           'Scan   '   you are being asked to enter text to locate
  165.           'Find   '    in the file, up to 31 characters may be entered
  166.  
  167.           '# lines?'   you are being asked to enter a 1 to 5 digit
  168.                        number that is the amount of lines to skip
  169.  
  170.           'Line #? '   you are being asked to enter a 1 to 5 digit
  171.                        line number to which the display is to be
  172.                        positioned
  173.  
  174.  
  175.       'message' may be one of:
  176.  
  177.           '*** Text not found ***'
  178.            the Scan/Text was not found in the file
  179.  
  180.           '   *** Top of file ***'
  181.            the first line of the file is being displayed
  182.  
  183.           '   *** End-of-file ***'
  184.            the last line of the file is being displayed
  185.                                                       DRLIST     Page 4
  186.  
  187.  Key functions and Commands
  188.  --------------------------
  189.  
  190.         On the COMMAND line, enter a letter or control key:
  191.  
  192.         Letter(s)     Default   Function
  193.         ---------     -------   ------------------------
  194.         A                       find next occurance of 'text'
  195.         B                       skip to end of file (bottom)
  196.         C               off     toggles closing of (shared) files
  197.         D                       toggles hex dump display mode
  198.         E               on      set hi-bit on, Eight-bit mode
  199.         F                       Find 'text' regardless of case
  200.         H or ?                  list commands (HELP)
  201.         K               off     toggle keyboard flush; if on, commands
  202.                                 may be queued up by holding a key down
  203.         L                       scroll left 20 columns
  204.         N                       down one (next) line
  205.         P               off     toggle printer on or off
  206.         Q                       display next matching file
  207.         R                       toggles ruler on top line
  208.         S               off     toggles hi-bit off, Seven-bit mode
  209.         T                       restart from first line (top)
  210.         U                       scroll up one page (23 lines)
  211.         W               off     toggle wrap of lines over 80 chars
  212.         X                       terminate, clear screen and exit to DOS
  213.         Z                       Exit to DOS with prompt on line 2
  214.  
  215.         0                       reset scroll to column 1
  216.  
  217.         *               off     toggles special * document filtering
  218.  
  219.  
  220.         #                       positions to a specific line number
  221.         +                       position a given number of lines forwards
  222.         -                       position a given number of lines backwards
  223.  
  224.         \text                   Find 'text' regardless of case
  225.         /text                   Scan for exact text match
  226.  
  227.         ,                       change background for main body of display
  228.         .                       change foreground for main body of display
  229.         <                       change background for top and bottom lines
  230.         >                       change foreground for top and bottom lines
  231.  
  232.         Enter or Space-bar      continue to next page
  233.         ESCape                  Display next matching file (like Q)
  234.                                                       DRLIST     Page 5
  235.  
  236.  Key functions and Commands (cont.)
  237.  --------------------------
  238.  
  239.  
  240.                 ________________________________
  241.  
  242.                  Numeric keypad with NumLock on
  243.                 ________________________________
  244.  
  245.  
  246.   #  over key        Function
  247.   -------------     -------------------------------------------
  248.   1  END             position to end of file (bottom)
  249.   7  HOME            restart from first line (top)
  250.   9  PgUp            scroll up one page, 23 lines
  251.   3  PgDn            scroll down one page, 23 lines
  252.  
  253.   4  left arrow      scroll left 20 columns
  254.   6  right arrow     scroll right 20 columns
  255.   8  up arrow        up one (previous) line
  256.   2  down arrow      down one (next) line
  257.  
  258.  
  259.     Control key      Function
  260.     -----------     -------------------------------------------
  261.  
  262.      alt-C           clone DRLIST.COM, change colors or options
  263.                      permanently in program file
  264.  
  265.  
  266.  Positioning to Lines
  267.  --------------------
  268.  
  269.            Each displayable line of the file is assigned a line number.
  270.         The first line is assigned line number 1.  The highest allowable
  271.         line number is 65535.  In order to determine the last line
  272.         number, the entire file must be read.  For this reason, the
  273.         first time that the END (bottom) command is issued, it will take
  274.         longer to process.
  275.  
  276.            If the Wrap option is in effect, there is one line number
  277.         required for each 80 bytes of the file records.
  278.  
  279.            If the hex dump option is in effect, there is one line number
  280.         required for each 16 bytes of the file.
  281.  
  282.            You may position to a specific line number by using the
  283.          # character key. When # is entered, you are prompted for the
  284.         line number to position to.  Enter the 1 to 5 digit line
  285.         number.  The display will now begin with that line number at the
  286.         top of the screen.
  287.  
  288.            To position forward or backward, you may use the + (plus), or
  289.         - (minus) keys.  You are prompted to enter the number of lines
  290.         to be skipped.  The display resumes at the line number shown on
  291.         the top (status) line, plus or minus the number of lines that
  292.         you specified.
  293.                                                       DRLIST     Page 6
  294.  
  295.  Cloning procedure
  296.  -----------------
  297.  
  298.            The screen colors, the display retrace testing (M), the file
  299.         closing (C) and ruler (R) options may be permanently set in
  300.         the program by using the alt-C cloning function.
  301.  
  302.            For cloning to take effect, the program must be called
  303.         DRLIST.COM and it must be on the current drive and in the current
  304.         directory.
  305.  
  306.            The clonable options (command toggles) are:
  307.  
  308.              M     = Mono monitor, affects retrace testing, no effect with ANSI
  309.              R     = use ruler on top line,
  310.              C     = file(s) are shared, not left open while displaying
  311.              D     = hex dump display, like the DEBUG format
  312.              W     = Wrap long lines
  313.              E/S/* = display all 256 values, or 7-bit, or special cases
  314.              K     = flush Keyboard each time a command is read
  315.  
  316.  
  317.                                                       DRLIST     Page 7
  318.  
  319.  DEBUG Information
  320.  -----------------
  321.  
  322.            An alternative to cloning is to use DEBUG to make permanent
  323.         changes. Here is a list of key items and their addresses:
  324.  
  325.            0126 - special lines 1 and 25 colors, default is 01 (blue)
  326.                   Refer to a technical reference guide for the
  327.                   attribute values for the colors that you want.
  328.            0128 - normal lines 2 thru 24 colors, default is 02 (green)
  329.            012A - bright color for Find/Scan, default is 0C (bright red)
  330.            012C - options; bits 0 through 6
  331.                    MRSD WHK.  M = mono, x'01'
  332.                               R = ruler, x'02'
  333.                               S = shared, x'04'
  334.                               D = hex display, x'08'
  335.                               W = wrap mode, x'10'
  336.                               H = hi-bit on, x'20'
  337.                               K = kybd flush, x'40'
  338.  
  339.                   By specifying the bit value, the option is enabled.
  340.                   For example, to enable Shared and Retrace, specify
  341.                   a hex value of 05.
  342.  
  343.            The letters and command keys may also be changed.  There are
  344.         two tables involved:  WHAT and WHERE.  The WHAT table contains a
  345.         list of one-byte keyboard codes.  The WHERE table contains a
  346.         list of two-byte addresses.  If you really want to change the
  347.         codes, here are the DEBUG addresses:
  348.  
  349.            0472 - *WHAT* eye catcher
  350.            0478 - list of ONE byte command letters and characters
  351.  
  352.            04A5 - *WHERE1* eye catcher
  353.            04AD - list of corresponding two byte offsets to routines
  354.  
  355.  
  356.         NOTE: These DEBUG addresses are version dependent.
  357.         ==================================================
  358.                                                       DRLIST     Page 8
  359.  
  360.  Screen attributes
  361.  -----------------
  362.  
  363.            The colors used for displaying the titles and main body of
  364.         text may be changed temporarily or permanently.  To make a
  365.         permanent change, the cloning command alt-C is used.  It
  366.         requires that the DRLIST.COM program file be on the current drive
  367.         and in the current directory.
  368.  
  369.            There are three classes of attributes used.  One for normal
  370.         display lines - lines 2 to 23 - another for special lines -
  371.         lines 1 and 24, and a third for the Find/Scan color.  The border
  372.         is not changed.  The foreground color applies to the characters
  373.         displayed.
  374.  
  375.         These color attributes may be changed by using function keys:
  376.  
  377.           For the main body of text:
  378.  
  379.             , (comma) - background color
  380.             . (period) - foreground color
  381.  
  382.           For the top and bottom lines:
  383.  
  384.             < (less than)    - background color
  385.             > (greater than) - foreground color
  386.  
  387.         Only one line is redisplayed when you change the "normal"
  388.         colors, background or foreground. The display is scrolled
  389.         up one line to reveal the next line with the new colors.
  390.  
  391.         Once you have decided upon the colors, use the alt-C key
  392.         combination to change the DRLIST.COM program file.
  393.  
  394.         If DRLIST is used from a remote computer, the default colors
  395.         used by DOS will be changed to those used by DRLIST.
  396.  
  397.                                                       DRLIST     Page 9
  398.  
  399.  Scanning for text
  400.  -----------------
  401.  
  402.  
  403.            You may use  Find (\)  to search for text  regardless  of the
  404.         case, or you may use Scan (/) to find an exact match.
  405.  
  406.            To scan for a character string, type a slash (/) followed  by
  407.         one or more (up to 31)  characters.  The scan text, but not  the
  408.         slash,  is  displayed  on  the  command  line.  The scan is case
  409.         sensitive.  That is, lower case scan text will only match  lower
  410.         lower case file text.
  411.  
  412.            While  the  program  is  searching  for  the text, the bottom
  413.         display line is changed to say "Scanning".
  414.  
  415.            If the text is found, the line containing it is displayed  as
  416.         a high-intensity line (bright color).
  417.  
  418.            If the text is NOT found, the bottom line (24) is changed  to
  419.         say '*** text not found ***', and the display remains unchanged.
  420.  
  421.            To find the next occurrance of the same text,  use the A)gain
  422.         command, or press the A key.
  423.  
  424.            If the PCED keyboard enhancement program is installed, the
  425.         up/down cursor keys may be used to recall and edit previously
  426.         entered Scan/Find text.
  427.  
  428.            In a shared file environment, if the file changes while being
  429.         listed, the file position may become invalid.  Use the 7 letter
  430.         command to insure proper file synchronization, or use the C
  431.         (shared) option.
  432.                                                       DRLIST    Page 10
  433.  
  434.  Filtering
  435.  ---------
  436.  
  437.            Filtering is the term used to describe the process that DRLIST
  438.         uses to format file data for displaying on a monitor. After data
  439.         is read from a file, it is filtered. The method of filtering
  440.         depends upon the options in effect.
  441.  
  442.            For a typical ASCII text file, the filter removes carriage
  443.         return and line feed characters, and expands TAB characters.
  444.  
  445.            The S, E, and * (asterisk) commands determine whether
  446.         characters above ASCII-127 are displayed.  If the hi-bit option
  447.         is off (S command), the filter strips the high order bit from
  448.         each character.  If the hi-bit option is on (E command), all
  449.         characters, including graphic characters above ASCII-127, are
  450.         displayed.
  451.  
  452.            The * (asterisk) command displays only ASCII characters
  453.         below 128 (x'80'), but treats the special characters x'8A' and
  454.         x'8D' as line-feed and carriage-return control characters.  Any
  455.         other characters above 127 are ignored.
  456.  
  457.            The Wrap option causes the filtering to insure that no line
  458.         exceeds the width of the monitor, e.g. 80 characters.
  459.  
  460.            The hex dump option (D key) causes the filtering to reformat
  461.         the file data into a DEBUG-like display format. The largest
  462.         file that can be "dumped" is 1 million bytes.
  463.  
  464.         NOTE: The EOF control character is ignored in this version.
  465.         ===========================================================
  466.                                                       DRLIST    Page 11
  467.  
  468.  Update history
  469.  --------------
  470.  
  471.  Lines beginning with | denote changes to the latest version.
  472.  
  473.         Version 5.83, May 6, 1986.
  474.  
  475.         Version 5.84, May 8, 1986.
  476.  
  477.         Version 5.85, May 9, 1986.
  478.  
  479.         Version 5.86, May 10, 1986
  480.  
  481.         Version 5.87, May 11, 1986
  482.  
  483.         Version 5.88, May 13, 1986
  484.  
  485.         Version 5.89, May 14, 1986
  486.  
  487.         Version 5.90, May 18, 1986
  488.  
  489.         Version 5.91, May 19, 1986
  490.  
  491.         Version G, June 14, 1986
  492.            - special version called DRLIST for use with BBS Doors or CTTY
  493.  
  494.         Version H, July 7, 1986
  495.            - restrict display to lines 1 through 24 to allow line 25
  496.              to be used by communications programs
  497.            - redisplay only last line when ., are used to change colors
  498.  
  499.         Version I, June 17, 1989
  500.            - correct console input problem using CTTY under OmniView
  501.            - add file sharing (via SHARE) for DOS 3 and later
  502.            - correct expansion of TABs in Help screen
  503.  
  504. |       Version J, Sept 17, 1989
  505. |          - correct prompt for filename
  506.  
  507.                                                       DRLIST    Page 12
  508.  
  509.  Special ANSI version
  510.  --------------------
  511.  
  512.         The special ANSI version of DRLIST uses DOS function 21 hex for
  513.         all display I/O. This means that the display will be slower,
  514.         but it also means that ANSI escape squences can be displayed,
  515.         and that DRLIST can be used by a remote computer via the CTTY
  516.         or BBS DOORS facility.
  517.  
  518.         The use of function keys, e.g. F1, and the cursor positioning
  519.         keys are not supported by all DOS environments or communications
  520.         programs. Therefore, the cursor positioning keys have been
  521.         redefined to be the numbers over those keys. By setting NumLock
  522.         on, the cursor positioning keys will have effect. For example,
  523.         the PgUp key may not work, but the 9 key will perform the PgUp
  524.         function. The Fn (function) keys have had letters assigned to them.
  525.  
  526.  
  527.                                                       DRLIST    Page 13
  528.  
  529.  Restrictions
  530.  ------------
  531.  
  532.         o  ANSI.SYS is required. (an equivalent may be used)
  533.            _____________________
  534.  
  535.         o  The program requires 60K bytes of memory. If more memory is
  536.            available, it is used to store more of the file in memory.
  537.  
  538.         o  The line number is currently limited to 65535.
  539.  
  540.         o  The file size is limited to 16 million bytes.
  541.  
  542.         o  PC-DOS Version 2.0 or later is required.
  543.  
  544.  
  545.         Written by Vernon Buerg for the  IBM PC using DOS 2.0 or
  546.         later, including DOS 3.3.
  547.  
  548.         DRLIST is supplied for personal, private use. Feel free to
  549.         distribute DRLIST given these restrictions:
  550.  
  551.           o  the program shall be supplied in its original,
  552.              unmodified form, which includes this documentation;
  553.  
  554.           o  no fee is charged.
  555.  
  556.           o  commmercial use is prohibited.
  557.  
  558.           o  the program may not be included - or bundled - with
  559.              other goods or services. Exceptions may be granted
  560.              upon written request only.
  561.  
  562.         If you are using DRLIST and find it of value, your gift in
  563.         any amount ($15 suggested) will be greatly appreciated.
  564.         Makes checks payable to Vernon D. Buerg. Thank you.
  565.  
  566.         For use by corporations and other institutions, please
  567.         contact me for a site licensing agreement.
  568.  
  569.                 Vernon D. Buerg
  570.                 139 White Oak Circle
  571.                 Petaluma, CA  94952
  572.  
  573.                 Data: (707) 778-8944 (VOR BBS)
  574.                 Compuserve: 70007,1212
  575.  
  576.